home *** CD-ROM | disk | FTP | other *** search
/ SPACE 1 / SPACE - Library 1 - Volume 1.iso / utilitys / 68 / turtle / turtle.doc < prev    next >
Encoding:
Text File  |  1987-07-06  |  23.4 KB  |  466 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.                               TURTLE 
  13.                     Version 2.10   March, 1987
  14.  
  15.                   A hard disk backup utility by: 
  16.                      
  17.                         George R. Woodside 
  18.                      5219 San Feliciano Drive 
  19.                     Woodland Hills, Ca. 91364 
  20.  
  21.  
  22.  
  23.  
  24.                       IF YOU READ NOTHING ELSE, 
  25.                          AT LEAST READ THIS! 
  26.  
  27.      To get started without reading any more of the documentation: 
  28.  
  29. 1)  Copy   TURTLE.PRG,   TURTLE.RSC,   TTLEXEC.TTP,and the  proper 
  30.     RAMdisk into the same directory. The RAMdisks are:
  31.           TRDNSS.PRG - Single sided disks, normal format
  32.           TRDNDS.PRG - Double sided disks, normal format
  33.           TRDTSS.PRG - Single sided disks, "TWISTER" format
  34.           TRDTDS.PRG - Double sided disks, "TWISTER" format
  35.  
  36. 2) Change the file type of any accessories to something other than 
  37.    .ACC to prevent them loading. 
  38.  
  39. 3) Remove all programs from your /AUTO folder except the hard disk 
  40.    boot program. 
  41.  
  42. 4) Power off your system and wait 10 seconds to insure a clean boot 
  43.    (especially if you have a reset-proof RAMdisk). 
  44.  
  45. 5) Restart your system, and open the directory with TURTLE.PRG and 
  46.    the other files. 
  47.  
  48. 6) Double click on TURTLE.PRG to start. 
  49.  
  50. 7) Select the necessary options.  They are all  described in their 
  51.    dialog boxes, and again under the HELP menu. 
  52.  
  53. 8) Select BACKUP under the FILE menu to begin writing disks. 
  54.  
  55. Notes: 
  56.    Only  the   RAMdisks supplied with TURTLE  will  work.  Do  not 
  57.    attempt to use any other RAMdisk. 
  58.  
  59.   The keyboard is scanned between files. You may cancel TURTLE at 
  60.   any time by  pressing CONTROL-C,  or press A or B to indicate a 
  61.   new disk is ready at any time. 
  62.  
  63.  
  64.                            INTRODUCTION 
  65.  
  66.      TURTLE is an extremely fast hard disk backup utility program.  
  67. It  requires  no special hardware,  and the floppies  written  are  
  68. standard TOS disks. To accomplish this speed, certain simple steps  
  69. must  be taken.  TURTLE requires just about all the RAM  you  have  
  70. (for double sided disks).  You should disable any accessories, and  
  71. remove  any  unnecessary programs from your  AUTO  folder,  before  
  72. running  TURTLE.  You may re-establish your accessories  and  AUTO  
  73. folder programs once the backup is complete,  but TURTLE will need  
  74. the RAM during the backup. The speed of this program will make the  
  75. minor inconvenience of a little file manipulating well worth it. 
  76.  
  77.      How can it be so fast, and  still  write  standard  floppies? 
  78. TURTLE creates a RAMdisk that has exactly the same characteristics 
  79. as a standard diskette.  It copies files from the hard  disk  into 
  80. the  RAMdisk,  writing as many files as can be fit into each disk. 
  81. When the RAMdisk is full, it dumps it as a track-by-track image to 
  82. a floppy.  It writes as many copies as you have requested, with or 
  83. without formatting the floppies.  The result  is  identical  to  a 
  84. floppy  that  was written directly, except that no time was wasted 
  85. moving back and forth to the directory and allocation  tables,  or 
  86. waiting  for  the  proper  sectors  to  be  available  during disk 
  87. rotation.  The time difference is staggering.  The only  catch  is 
  88. that  you  must  insure  that  all the RAM is available before you 
  89. begin.  That is very easy, and very well worth it. 
  90.  
  91.      Why call it "TURTLE"?  Well, backing up hard disks is  always 
  92. a  slow  task,  so the name fits.  Since there are already several 
  93. programs available with the name "BACKUP", I had intended to  call 
  94. this one "HARDBACK".  Since turtles have hard backs anyway..... 
  95.  
  96.  
  97.                                 DESKTOP 
  98.  
  99.      TURTLE  runs  from  the  standard  GEM  desktop.  It  may  be 
  100. executed  by double-clicking on the TURTLE.PRG file.  The resource 
  101. file TURTLE.RSC must be in the same directory  as  TURTLE.PRG,  as 
  102. must  be  the  backup  utility TTLEXEC.TTP and the proper RAMdisk: 
  103.           TRDNSS.PRG - Single sided disks, normal format
  104.           TRDNDS.PRG - Double sided disks, normal format
  105.           TRDTSS.PRG - Single sided disks, "TWISTER" format
  106.           TRDTDS.PRG - Double sided disks, "TWISTER" format
  107.  
  108.   TURTLE requires a large amount of memory to use the RAMdisk  and 
  109. execute  at the same time.  You should disable any accessories and 
  110. remove any non-critical programs  from  your  AUTO  folder  before 
  111. attempting  to execute it.  You must have a 1 megabyte machine, or 
  112. larger, to run TURTLE. 
  113.  
  114.       It includes an ABOUT  menu  item  under  the  DESK  menu  to 
  115. identify itself.  Clicking on it will display a normal dialog box, 
  116. identifying the date and version of the program. 
  117.  
  118.      Under the FILE menu is the usual QUIT item, to terminate  the 
  119. program  without  executing a backup.  There is also a BACKUP menu 
  120. item, to initiate a backup, and a SYSTEM RESET  item.  The  SYSTEM 
  121. RESET item is there to make it easier to free the RAM necessary to 
  122. execute  a  backup,  and insure that the folders  accessed  before 
  123. TURTLE is executed do not interfere with the backup.  It is a good 
  124. idea  to  do  a reset just before beginning TURTLE  to  clear  the 
  125. folder  limits  (see  the  warning  below).    Since  a   manually  
  126. triggered  system  reset,   by pressing  the  reset  button,  will 
  127. not clear the bits in the drive allocation map,  this system reset  
  128. function  will  clear  the  bit associated  with  drive M:  before 
  129. executing  the  reset.   If you are using a  reset-proof  RAMdisk, 
  130. however, there is no  choice  but  to power  off  your  system and 
  131. re-boot (without the RAMdisk) to free the memory.  
  132.  
  133.                              OPTIONS 
  134.  
  135.      TURTLE runs from the desktop, using  standard  GEM  drop-down 
  136. menus  for  entering  options.  There is a HELP menu item for each 
  137. OPTION item, to provide information at any time. 
  138.  
  139. Archive: 
  140.           This option inhibits  a  normal  function,  setting  the 
  141.           archive bit.  When a file is copied, TURTLE will set the 
  142.           bit unless the ARCHIVE option has been used  to  disable 
  143.           the   feature.   This   bit  can  be  used  to  instruct 
  144.           subsequent backups to copy only  the  files  which  have 
  145.           changed since the last time TURTLE (or some other backup 
  146.           utility which set the archive  bit)  was  executed.  The 
  147.           default for this switch is to set the archive bit.  When 
  148.           the checkmark is displayed beside  the  Archive  option, 
  149.           the archive bit will be set on all files copied. 
  150.  
  151. Extra Copies: 
  152.           This  option  is used to generate extra  copies  of  any 
  153.           disk written  during backup.  Normally, only one copy of 
  154.           each disk is written.   To request  additional   copies,  
  155.           enter  the  number  of  copies  desired.   The   default 
  156.           for this option is to write one backup copy.   When  the  
  157.           checkmark is displayed beside this option,  either 2  or 
  158.           three copies of each disk will be written. 
  159.  
  160. Format: 
  161.           This is the diskette format option.  TURTLE assumes that 
  162.           the disks to be written to are already formatted, unless 
  163.           this  option is used to override that  assumption.  When 
  164.           disks  in  the  "TWISTER" format  are  used,  they  must 
  165.           already be formatted.  TURTLE will not format  "TWISTER" 
  166.           disks.  It  is not necessary that the disks  be  erased, 
  167.           since anything on them will be over-written. It is never 
  168.           harmful to use the format option,  but it will cause the 
  169.           program to run a bit slower. The default for this option 
  170.           is  to  write  to  floppies  without  formatting.   When 
  171.           the checkmark  is  displayed  beside  this  option   the 
  172.           diskettes will be formatted before they are written.  
  173.  
  174. Incremental: 
  175.           This  option  indicates  that  the  backup   should   be 
  176.           incremental - that only the files altered since the last 
  177.           backup should be  copied.  This  can  shorten  the  time 
  178.           required  to  back  up  a drive when few files have been 
  179.           changed.  It does require, however, that the  user  keep 
  180.           the  original  backup,  plus the intervening incremental 
  181.           backups, to be able to re-construct the contents of  the 
  182.           drive.  The default for this option is to backup all the 
  183.           files in  the  paths  entered.  When  the  checkmark  is 
  184.           displayed  beside  this  option,  only the changed files 
  185.           will be copied. 
  186.  
  187. Double Sided: 
  188.           This option is used to indicate that the backup will  be 
  189.           done  to double-sided disks,  rather than  single  sided 
  190.           disks.  It  is  imperative  that the  proper  option  be 
  191.           selected,  matching  the diskettes to be  used.  If  the 
  192.           backup is executed with the wrong diskette  option,  the 
  193.           backup will not be useable and may create errors  during 
  194.           floppy writing.  The default for this option is to write 
  195.           double  sided  disks.  When the checkmark  is  displayed 
  196.           beside this option,  double sided disks will be written. 
  197.            
  198. Disk Numbers: 
  199.           This option is used to define the number assigned to the 
  200.           first   diskette   written.   Normally,   diskettes  are 
  201.           numbered beginning with one.  However, if  a  backup  is 
  202.           being  executed by paths (to avoid the 40 folder limit), 
  203.           subsequent paths may be better organized if the  numbers 
  204.           assigned  to the disks are sequential.  This option will 
  205.           offer a dialog box which can be used to set  the  number 
  206.           assigned  to  the first disk written.  The default is to 
  207.           start numbering disks with  1.  When  the  checkmark  is 
  208.           displayed  beside  this option, some number other than 1 
  209.           has been selected to begin assigning to disks. 
  210.  
  211. Path: 
  212.           This option is used to specify the disk  path  to  read. 
  213.           All  files  (or all non-archived files if INCREMENTAL is 
  214.           set) in the named path will be read and  copied  to  the 
  215.           diskettes.  Only  the  files  in  the named path will be 
  216.           read or marked with  the  ARCHIVE  bit  (if  ARCHIVE  is 
  217.           enabled).  The  default for this option is the path from 
  218.           which  TURTLE  was  initiated.  When  the  checkmark  is 
  219.           displayed by this option, the path has been changed from 
  220.           the default. 
  221.  
  222. Files Only: 
  223.           This option is used to limit the path  following  option 
  224.           of  TURTLE.  Normally,  TURTLE  will  begin  at the path 
  225.           named, and follow all folders in that path, copying  all 
  226.           files in all folders (unless INCREMENTAL is set).  Then, 
  227.           after all folders in the path have been copied, all  the 
  228.           files  in  the  named  path are copied.  Using the FILES 
  229.           ONLY option will prevent TURTLE from opening any of  the 
  230.           folders  in  the path.  Only the files in the named path 
  231.           will be copied.  The default for this option is to  open 
  232.           the folders, and back up all the files in the folders as 
  233.           well as  those  in  the  path.  When  the  checkmark  is 
  234.           displayed  by  this  option,  only the files in the path 
  235.           named, but not those in the folders, will be backed up. 
  236.  
  237.                             EXECUTION 
  238.  
  239.      Before TURTLE can be executed, your system must not be in low 
  240. res  mode,  and  there  must  be  an  adequate  amount  of  memory 
  241. available.  You must disable any accessories or unnecessary "AUTO" 
  242. programs  to  insure  that  there is space available for TURTLE to 
  243. execute. 
  244.  
  245.                      ===>>> WARNING!!! <<<=== 
  246.  
  247.      There is a problem in GEMDOS dealing with folders  (sometimes 
  248. referred to as sub-directories).  GEMDOS becomes unstable when too 
  249. many folders are accessed.  Currently, 40 folders is assumed to be 
  250. a safe limit for folders on a system.  TURTLE uses some techniques 
  251. to make the folder problem less severe.  When you specify the path 
  252. you  wish to backup,  there may be folders in that  path.  Folders 
  253. which  reside  directly in the path name  may  themselves  contain 
  254. other folders.  TURTLE will "clear" the folder count each time  it 
  255. completes backing up a folder which resides directly in the  named 
  256. path.  TURTLE can not clear the folder count during the backing up 
  257. of any other folder,  only when it finishes a folder at the  "top" 
  258. of the named path. For example, if drive "C:" contains 80 folders, 
  259. and many of those contain more folders, like this:
  260.  
  261.      C:\FOLDER00 (contains 15 more folders)
  262.      C:\FOLDER01 (contains 12 more folders)
  263.      C:\FOLDER02 (contains 24 more folders)
  264.      C:\FOLDER03 (contains no more folders)
  265.  
  266.      C:\FOLDER78 (contains 31 more folders)
  267.      C:\FOLDER79 (contains 13 more folders)
  268.  
  269. and  you  instructed  TURTLE to back  up  drive  "C:",  you  would 
  270. encounter no problems. As TURTLE backed up C:\FOLDER00, the folder 
  271. count would climb to 19 (15 folders,  C:\,  C:\FOLDER00,  M:,  and 
  272. M:\FOLDER00).  On the RAMdisk,  only the folders in the path being 
  273. are counted. All other folders on the RAMdisk are removed from the 
  274. count  as  soon  as they are completed.  When  the  last  file  of 
  275. FOLDER00 was copied, before FOLDER01 was started, the folder count 
  276. would drop to 3 (C:,  C:\FOLDER01, and M:), then rise to 4 as soon 
  277. as  M:\FOLDER01 was created.  Drive C:  itself could  contain  any 
  278. number  of  folders,  as far as TURTLE was  concerned.  You  would 
  279. probably have problems with other programs,  however,  so this  is 
  280. still not considered wise.  If any single folder at the top  level 
  281. of  drive C:  contained more than 40 folders,  though,  you  could 
  282. experience  problems with TURTLE.  If this is the case,  you  must 
  283. back up drive C:  by selecting groups of folders,  then re-running 
  284. with  the single folders which contain more than  40  folders.  If 
  285. FOLDER31  contained  90 folders (counting  all  folders  contained 
  286. within  those  folders),  you would have to back  up  all  folders 
  287. except 31,  then back up FOLDER31 by itself.  The PATH dialog  box 
  288. has been widened to make this easier.  The simplest way to explain 
  289. this is to think that the 40 folder limit has been moved one level 
  290. of folders lower in the path that you enter.  It may be easier  to 
  291. grasp  the idea if you watch the folder count climb as the  backup 
  292. is running, then suddenly drop as a folder is completed.
  293.   
  294.     Once TURTLE begins, it will start copying files,  even  though 
  295. there  are  no  disks ready.  Do not be concerned.  TURTLE will be 
  296. establishing the RAMdisk images,  and  no  floppies  are  required 
  297. until  the  RAMdisk is full.  Once the RAMdisk is full, it will be 
  298. dumped to the floppies, and will post messages to  identify  which 
  299. disk  is which in sequence.  If you do not stay ahead of TURTLE in 
  300. keeping disks ready, it will start ringing the console bell  until 
  301. you return, and provide more diskettes. 
  302.  
  303.     TURTLE will keep all the files in a  folder  together,  in  an 
  304. identically  named  folder,  on  the  floppy  image.  Of course, a 
  305. single hard disk folder may be split across several  floppies.  If 
  306. no  files are to be copied from a folder, no empty folders will be 
  307. created.  The sequence of the files in  the  folder  will  be  the 
  308. largest  file  that  fits  first.  This  allows  TURTLE to use the 
  309. floppies as efficiently as possible.  TURTLE will not  attempt  to 
  310. copy  a  file that is too large to fit on a blank floppy, but will 
  311. log a message on the screen (remember that  each  folder  requires 
  312. 1K, so there is less space available when folders are nested). 
  313.  
  314.  
  315.                            THE DISPLAY 
  316.  
  317.      TURTLE maintains an informative  display  during  the  backup 
  318. process.  It  requires  lines of 80 characters, so you must not be 
  319. in low res mode.  At the top  is  the  sign  on  banner,  and  the 
  320. current  version  number.  Next  is the status line for the floppy 
  321. drives.  Each drive will always have a status indicated: 
  322.  
  323. DISK NEEDED 
  324.      Used  only  at  startup.  Be  sure  an  appropriate  disk  is 
  325.      inserted, and press the key corresponding to the floppy drive 
  326.      (A or  B,  upper  or  lower  case).  When  a  disk  has  been 
  327.      inserted,  and the proper key pressed, the status will change 
  328.      to READY.  You may change disks any time that the disk access 
  329.      for  the  floppy  drive  is not on, and press the keys at any 
  330.      time.  TURTLE is designed to allow you to set  up  two  disks 
  331.      and  walk  off.  It  will  use  them both, then start ringing 
  332.      bells to let you know when it needs a new pair.  It will  let 
  333.      you  know  what order the disks were written in.  If you stay 
  334.      ahead of TURTLE in keeping disks  ready,  it  will  alternate 
  335.      between  drive  A and B.  If both disks are full, it will use 
  336.      whichever one you key in as ready first.  If you do not  have 
  337.      a  second  drive,  do  not press the "B" key, and TURTLE will 
  338.      work with drive "A"  exclusively.  If  you  re-use  the  same 
  339.      disks  for  backup,  with  labels on them, it is very easy to 
  340.      keep them in sequence. 
  341.  
  342. FULL Disk ##  Copy  # 
  343.      Informs you that the floppy in the designated drive is  full, 
  344.      and  must  be  changed.  The  ## is the number of the disk in 
  345.      sequence, and the # will show which copy it is, when multiple 
  346.      copies are requested.  You may change a disk at any time, and 
  347.      press the keys at any time, so long as you do not attempt  to 
  348.      remove a disk while the drive's access light is on. 
  349.  
  350. READY 
  351.      You have indicated that a blank disk is in the  drive,  ready 
  352.      for  writing.  When  the  RAMdisk is full, this drive will be 
  353.      written to.  If both drives are READY, TURTLE will  write  to 
  354.      whichever one was not used last. 
  355.  
  356. DISK ERROR 
  357.      Well,  these  things  happen.   TURTLE  is   very   good   at 
  358.      recovering, however.  Since the entire image of the floppy is 
  359.      in the RAMdisk, just insert a new floppy in the drive,  press 
  360.      RETURN,  and  TURTLE will start writing that copy over.  Just 
  361.      discard, re-cycle, or furiously  mangle  the  disk  with  the 
  362.      error.  It  is  unimportant.  Your  backup  will be perfectly 
  363.      valid, no matter how many diskette errors occur.  Ignore  any 
  364.      disks  with  errors,  and  keep the ones TURTLE identified as 
  365.      FULL.  When an error occurs, you must replace the disk in the 
  366.      drive  with  the error, and press RETURN.  TURTLE will not go 
  367.      off writing on other (possibly labelled) disks and leave  bad 
  368.      ones lying around.  This helps keeps things orderly. 
  369.  
  370. TERMINATION PENDING 
  371.      You have pressed the terminate key "T".  TURTLE  will  finish 
  372.      writing   the   current   disk   (however  many  copies  were 
  373.      requested), then stop  executing.  If  the  Archive  bit  was 
  374.      being  set, only the files copied will be marked as archived. 
  375.      All files copied will  have  been  properly  marked,  so  the 
  376.      backup  may  be  restarted at a later time, and the remaining 
  377.      files will be copied. 
  378.  
  379. Read error. Options: A=Abort Backup. S=Skip this file:
  380.      A read error has occurred on the hard disk.  TURTLE is unable 
  381.      to  backup  the current file.  You may abort  the  backup  by 
  382.      pressing  A  (or a).  The abort is immediate.  Files  in  the 
  383.      RAMdisk  are not copied to floppies.  You may skip  the  file 
  384.      with the read error by pressing S (or s), and the backup will 
  385.      continue with the next file.
  386.  
  387.      Other lines on the display are clearly  labelled:  the  input 
  388. request being processed, the current path being copied, the number 
  389. of files in the path, how many  remain  to  be  copied,  and  byte 
  390. sizes.  There  is  a  folder count displayed.  Remember that it is 
  391. only the number of folders read or written  by  TURTLE,  and  only 
  392. during  the  current execution.  There is a log of files that have 
  393. been copied, and their sizes.  It starts  at  the  middle  of  the 
  394. screen, and scrolls down.  The file being copied is the one at the 
  395. top of the list, and it will scroll  down  and  off  the  page  as 
  396. subsequent files are copied. 
  397.  
  398.                              KEYBOARD
  399.  
  400.      While  the  backup  is running,  TURTLE  keeps  checking  the 
  401. keyboard.  You can type in commands at any time.  TURTLE will  see 
  402. them  within one or two seconds,  as soon as the current disk  I/O 
  403. operation is completed.  All commands are a single letter,  and do 
  404. not require that the RETURN key be pressed. The following commands 
  405. are active at any time, except when a disk I/O has occurred:
  406.  
  407.      A (or a) - a floppy disk has been inserted in drive A, and is            
  408.      ready for use.
  409.  
  410.      B (or b) - a floppy disk has been inserted in drive B, and is            
  411.      ready for use.
  412.  
  413.      T  (or  t) - terminate the program after the  current  floppy 
  414.      disk. All copies requested will be written before termination 
  415.      occurrs.  If the ARCHIVE option was requested, only the files 
  416.      backed up are marked as archived.
  417.  
  418.      Control-C  -   Cancel the program immediately.  Files  copied 
  419.      into the RAMdisk are not copied to a floppy.
  420.  
  421.  
  422.               CREDIT WHERE CREDIT IS DUE DEPARTMENT 
  423.  
  424.      TURTLE could not function without the  use  of  its  RAMdisk. 
  425. This one has special functions and characteristics I have added to 
  426. support TURTLE.  TURTLE absolutely will not work  with  any  other 
  427. RAMdisk,  so  don't  bother  trying.  This particular RAMdisk is a 
  428. highly modified version of one originally written by  Landon  Dyer 
  429. of  Atari,  and  placed in the public domain.  My thanks to Landon 
  430. Dyer for the use of his work. 
  431.  
  432.                              SUMMARY 
  433.  
  434.      TURTLE works quite well, and with (I  think)  amazing  speed. 
  435. It  is even smart enough to not copy unused tracks at the end of a 
  436. diskette, but it will format them if formatting has been requested 
  437. (who needs a partially formatted disk?).  The most important thing 
  438. is to be sure you free enough RAM to build the RAMdisk and run the 
  439. program  before  beginning.  TURTLE is fairly bullet proof, and is 
  440. very informative while running.  You can kill it at most any  time 
  441. by  pressing  Control-C, and it will stop almost immediately.  You 
  442. can request that it stop at the end of all copies of  the  current 
  443. disk  by  pressing  "T".  You  do  not have to wait for it to need 
  444. disks to make them ready,  you  may  press  the  appropriate  keys 
  445. whenever you have inserted the disks. 
  446.  
  447.      TURTLE is really only a GEM desktop front end for the program 
  448. which does the backup work, called TTLEXEC.TTP.  TURTLE writes one 
  449. command line, then uses it to invoke TTLEXEC.TTP to  do  the  real 
  450. work.  You can use TTLEXEC.TTP from the command line without using 
  451. TURTLE if you like.  See TTLEXEC.MAN for documentation. 
  452.  
  453.      TURTLE is over a quarter million bytes of source code,  which 
  454. is  not included in the .ARC file.  The programs are  copyrighted, 
  455. but  released for public distribution.  TURTLE is not to  be  sold 
  456. except for nominal charges for media, reproduction, and/or connect 
  457. charges while downloading.  
  458.  
  459.      If TURTLE gives you any trouble, or you have any suggestions, 
  460. please feel free to contact: 
  461.  
  462.      George R.  Woodside            Compuserve PPN 76537,1342 
  463.      5219 San Feliciano Dr. 
  464.      Woodland Hills, Ca. 91364 
  465.  
  466.